Working with the Prizm Platform Services > Developer Reference - Prizm Services > PCC RESTful API > Health Status |
Returns the following HTTP status codes to reflect the overall health of the Prizm Services:
This URL is intended to provide a quick, easily parseable indication as to the health of Prizm Services. For more information about the current health, use GET /Service/Current/Info.
Http Method
GET
Resource URL
/PCCIS/V1/Service/Current/Health
Parameters
None
Request Body
None
Response Body
OK | for HTTP status code 200 |
None/Empty | for HTTP status code 500 |
Example |
Copy Code
|
---|---|
GET http://localhost:18681/PCCIS/V1/Service/Current/Health
|
Example Response |
Copy Code
|
---|---|
200 OK |
This API returns a JSON object indicating the health of Prizm Services.
Http Method
GET
Resource URL
/PCCIS/V1/Service/Current/Info
Parameters
None
Request Body
None
Response Body
If successful, this method returns the following properties:
Property Name |
Value |
Description |
serviceStatus |
String |
Status of Prizm Services.
|
licenseStatus |
String |
Information about the PCC license.
|
instances |
list |
Information about individual instances of Prizm Services. In the current version, only one instance will be returned. |
Example |
Copy Code
|
---|---|
GET http://localhost:18681/PCCIS/V1/Service/Current/Info
|
Example Response |
Copy Code
|
---|---|
{ "serviceStatus": "running", "licenseStatus": "licensed as ...", "instances": [ { "serviceStatus": "running", "pccisVersion": "X.X.XXXX.X", "runtimeVersion": "X.X.XXXXX.XXXXX", "operatingSystem": "Microsoft Windows NT 6.1.7601 Service Pack 1", "startTime": "2014-11-21T22:21:39.7525625Z", "instanceId": "myhostname", "childServices": [ { "name": "PCC Imaging Proxy Server", "serviceStatus": "running", "version": "X.X.XXXX.XXXX" }, { "name": "PCC Imaging Conversion Service", "serviceStatus": "running", "version": "X.X.XXXX.XXXX" }, { "name": "PCC Raster Conversion Service", "serviceStatus": "running", "version": "X.X.XXXX.XXXX" }, { "name": "PCC Office Conversion Service", "serviceStatus": "running", "version": "X.X.XXXX.XXXX" } ] } ] } |